Apple Pay API一覧
※idPass版にのみ対応しています。json版には対応しておりません。
HTTP仕様(.idPass)
Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: text/plain;charset=windows-31j |
|
Status Code |
200:常に200を返却 |
EntryTranBrandtoken 取引登録
これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。
リクエスト
ShopID |
必須
半角英数13桁 固定
ショップID
|
|
---|---|---|
ShopPass |
必須
半角英数64桁
ショップパスワード
|
|
OrderID |
必須
半角英数記号27桁
オーダーID
|
|
JobCd |
必須
処理区分
|
|
ItemCode |
半角英数7桁
商品コード
通常は省略してください。カード会社から指定がある場合のみ、その値を設定します。省略時は0000990を適用します。
|
|
Amount |
必須
半角数字7桁
利用金額
|
|
Tax |
半角数字7桁
税送料
|
/payment/EntryTranBrandtoken.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=CAPTURE&Amount=1000
ExecTranBrandtoken 決済実行
オーソリを実行します。
リクエスト
ShopID |
必須
半角英数13桁 固定
ショップID
|
|
---|---|---|
ShopPass |
必須
半角英数64桁
ショップパスワード
|
|
AccessID |
必須
半角英数32桁 固定
取引ID
|
|
AccessPass |
必須
半角英数32桁 固定
取引パスワード
|
|
OrderID |
必須
半角英数記号27桁
オーダーID
|
|
TokenType |
半角英数8桁
トークン種別
利用するトークンの取得元を設定します。
|
|
Token |
トークン
端末から取得したトークンを設定してください。
|
|
SiteID |
半角英数13桁
サイトID
|
|
SitePass |
半角英数10桁
サイトパスワード
|
|
MemberID |
半角英数60桁
会員ID
|
|
SeqMode |
半角数字1桁 固定
連番モード
0:論理(省略値)
|
|
TokenSeq |
半角数字4桁
トークン連番
複数トークンを登録している会員について、どのトークンを利用するか番号で指定します。省略した
|
|
ClientField1 |
全半角100バイト
加盟店自由項目1
|
|
ClientField2 |
全半角100バイト
加盟店自由項目2
|
|
ClientField3 |
全半角100バイト
加盟店自由項目3
|
/payment/ExecTranBrandtoken.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
Status |
半角英数16桁
取引状態
決済実行された結果の状態を返却します。
|
|
---|---|---|
OrderID |
半角英数記号27桁
オーダーID
|
|
Forward |
半角英数7桁
仕向先コード与信を行ったカード会社の会社コードを返却します。 |
|
Approve |
半角英数7桁
承認番号カード会社が発行した与信の承認番号を返却します。 |
|
TranID |
半角英数28桁
トランザクションID弊社が処理を行う毎に発行している処理番号を返却します。 |
|
TranDate |
半角数字14桁 固定
決済日付【決済実行】を実施した日時を返却します。(yyyyMMddHHmmss形式) |
|
ClientField1 |
全半角100バイト
加盟店自由項目1
|
|
ClientField2 |
全半角100バイト
加盟店自由項目2
|
|
ClientField3 |
全半角100バイト
加盟店自由項目3
|
Status=AUTH&OrderID=ORDER0000001&Forward=2a99663&Approve=1602624&TranID=2208031130111111111111750389&TranDate=20220803113011&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3
ErrCode=E01&ErrInfo=E01040001
VoidTranBrandtoken 決済取消
一度オーソリ取得した取引に対し、与信枠を取り消します。
リクエスト
ShopID |
必須
半角英数13桁 固定
ショップID
|
|
---|---|---|
ShopPass |
必須
半角英数64桁
ショップパスワード
|
|
AccessID |
必須
半角英数32桁 固定
取引ID
|
|
AccessPass |
必須
半角英数32桁 固定
取引パスワード
|
|
OrderID |
必須
半角英数記号27桁
オーダーID
|
/payment/VoidTranBrandtoken.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
AccessID |
半角英数32桁 固定
取引ID
|
|
---|---|---|
AccessPass |
半角英数32桁 固定
取引パスワード
|
|
Status |
半角英数16桁
取引状態
【決済取消】を実行した結果の取引ステータスです。
|
|
Forward |
半角英数7桁
仕向先コード与信を行ったカード会社の会社コードを返却します。 |
|
Approve |
半角英数7桁
承認番号カード会社が発行した与信の承認番号を返却します。 |
|
TranID |
半角英数28桁
トランザクションID当社が処理を行う毎に発行している処理番号を返却します。 |
|
TranDate |
半角数字14桁 固定
決済日付
与信を実施した日付を返却します。
|
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Status=VOID&Forward=2a99663&Approve=1602624&TranID=2208031130111111111111750389&TranDate=20220803113012
ErrCode=E01&ErrInfo=E01040001
SalesTranBrandtoken 売上確定
オーソリ済の取引に対し、売上の確定を行います。
リクエスト
ShopID |
必須
半角英数13桁 固定
ショップID
|
|
---|---|---|
ShopPass |
必須
半角英数64桁
ショップパスワード
|
|
AccessID |
必須
半角英数32桁 固定
取引ID
|
|
AccessPass |
必須
半角英数32桁 固定
取引パスワード
|
|
OrderID |
必須
半角英数記号27桁
オーダーID
|
|
Amount |
必須
半角数字7桁
確定金額
【取引登録】で指定した値を設定します。
|
|
Tax |
半角数字7桁
確定税送料
【取引登録】で指定した値を設定します。
|
/payment/SalesTranBrandtoken.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
AccessID |
半角英数32桁 固定
取引ID
|
|
---|---|---|
AccessPass |
半角英数32桁 固定
取引パスワード
|
|
Status |
半角英数16桁
取引状態
【実売上】を実行した結果の取引ステータスです。
|
|
Forward |
半角英数7桁
仕向先コード与信を行ったカード会社の会社コードを返却します。 |
|
Approve |
半角英数7桁
承認番号カード会社が発行した与信の承認番号を返却します。 |
|
TranID |
半角英数28桁
トランザクションID当社が処理を行う毎に発行している処理番号を返却します。 |
|
TranDate |
半角数字14桁 固定
決済日付
与信を実施した日付を返却します。
|
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Status=SALES&Forward=2a99663&Approve=1602624&TranID=2208031130111111111111750389&TranDate=20220803113012
ErrCode=E01&ErrInfo=E01040001
RefundTranBrandtoken 返金
売上確定済の取引に対し、返品処理を行います。
リクエスト
ShopID |
必須
半角英数13桁 固定
ショップID
|
|
---|---|---|
ShopPass |
必須
半角英数64桁
ショップパスワード
|
|
AccessID |
必須
半角英数32桁 固定
取引ID
|
|
AccessPass |
必須
半角英数32桁 固定
取引パスワード
|
|
OrderID |
必須
半角英数記号27桁
オーダーID
|
|
Amount |
必須
半角数字7桁
返品金額
【取引登録】で指定した値を設定します。
|
|
Tax |
半角数字7桁
返品税送料
【取引登録】で指定した値を設定します。
|
/payment/RefundTranBrandtoken.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
AccessID |
半角英数32桁 固定
取引ID
|
|
---|---|---|
AccessPass |
半角英数32桁 固定
取引パスワード
|
|
Status |
半角英数16桁
取引状態
【返品】を実行した結果の取引ステータスです。
|
|
Forward |
半角英数7桁
仕向先コード与信を行ったカード会社の会社コードを返却します。 |
|
Approve |
半角英数7桁
承認番号カード会社が発行した与信の承認番号を返却します。 |
|
TranID |
半角英数28桁
トランザクションID当社が処理を行う毎に発行している処理番号を返却します。 |
|
TranDate |
半角数字14桁 固定
決済日付
与信を実施した日付を返却します。
|
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Status=RETURN&Forward=2a99663&Approve=1602624&TranID=2208031130111111111111750389&TranDate=20220803113012
ErrCode=E01&ErrInfo=E01040001
ChangeTranBrandtoken 金額変更
決済が完了した取引に対し、金額の変更を行います。
リクエスト
ShopID |
必須
半角英数13桁 固定
ショップID
|
|
---|---|---|
ShopPass |
必須
半角英数64桁
ショップパスワード
|
|
AccessID |
必須
半角英数32桁 固定
取引ID
|
|
AccessPass |
必須
半角英数32桁 固定
取引パスワード
|
|
OrderID |
必須
半角英数記号27桁
オーダーID
|
|
JobCd |
必須
処理区分
|
|
Amount |
必須
半角数字7桁
利用金額
|
|
Tax |
半角数字7桁
税送料
|
/payment/ChangeTranBrandtoken.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&JobCd=&Amount=1000
レスポンス
正常
AccessID |
半角英数32桁 固定
取引ID
|
|
---|---|---|
AccessPass |
半角英数32桁 固定
取引パスワード
|
|
Status |
半角英数16桁
取引状態
【金額変更】を実行した結果の取引ステータスです。
|
|
Forward |
半角英数7桁
仕向先コード与信を行ったカード会社の会社コードを返却します。 |
|
Approve |
半角英数7桁
承認番号カード会社が発行した与信の承認番号を返却します。 |
|
TranID |
半角英数28桁
トランザクションID当社が処理を行う毎に発行している処理番号を返却します。 |
|
TranDate |
半角数字14桁 固定
決済日付
与信を実施した日付を返却します。
|
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Status=RETURN&Forward=2a99663&Approve=1602624&TranID=2208031130111111111111750389&TranDate=20220803113012
ErrCode=E01&ErrInfo=E01040001
TradedBrandtoken 取引後トークン登録
指定した会員にApplePay(ブランドトークン)情報を登録します。
リクエスト
SiteID |
必須
半角英数13桁
サイトID
|
|
---|---|---|
SitePass |
必須
半角英数10桁
サイトパスワード
|
|
MemberID |
必須
半角英数記号60桁
会員ID
|
|
ShopID |
必須
半角英数13桁 固定
ショップID
|
|
ShopPass |
必須
半角英数64桁
ショップパスワード
|
|
OrderID |
必須
半角英数記号27桁
オーダーID
|
|
DefaultFlag |
半角英数1桁 固定
デフォルトフラグ
0:デフォルトとしない(省略値)
|
|
SeqMode |
半角英数10桁
連番モード
0:論理(省略値)
|
|
TokenSeq |
半角数字4桁
トークン連番
更新対象のトークン連番を指定します。連番モードで1(物理)を指定した場合のみ有効です。 |
/payment/TradedBrandtoken.idPass
SiteID=tsite99887701&SitePass=PASSWORD&MemberID=Member00&ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001
レスポンス
TokenSeq=0001&CardNoToken=C1+2MnMKh7xuFkiOWHvJu7ToZo5Cp5yFrVafcPG5f2c=&Forward=2a99663
ErrCode=E01&ErrInfo=E01040001
DeleteBrandtoken トークン削除
指定した会員のApplePay(ブランドトークン)情報を削除します。
リクエスト
SiteID |
必須
半角英数13桁
サイトID
|
|
---|---|---|
SitePass |
必須
半角英数10桁
サイトパスワード
|
|
MemberID |
必須
半角英数記号60桁
会員ID
|
|
SeqMode |
必須
半角数字1桁 固定
連番モード
0:論理(省略値)
|
|
TokenSeq |
必須
半角数字4桁
トークン連番削除するトークンの連番です。 |
/payment/DeleteBrandtoken.idPass
SiteID=tsite99887814&SitePass=PASSWORD&MemberID=Member00&SeqMode=1&TokenSeq=0001
SearchBrandtoken トークン照会
会員に登録されているApplePay(ブランドトークン)情報を返却します。
リクエスト
SiteID |
必須
半角英数13桁
サイトID
|
|
---|---|---|
SitePass |
必須
半角英数10桁
サイトパスワード
|
|
MemberID |
必須
半角英数記号60桁
会員ID
|
|
SeqMode |
必須
半角英数1桁
連番種別
0:論理(省略値)
|
|
TokenSeq |
半角数字4桁
トークン連番
参照するトークンの連番です。省略した場合、会員に登録されている全てのトークン情報を返します。
|
/payment/SearchBrandtoken.idPass
SiteID=tsite99887814&SitePass=PASSWORD&MemberID=Member00&SeqMode=1
レスポンス
正常
TokenSeq |
トークン連番トークンの連番です。API呼び出し時のSeqModeで指定された連番を返却します。 |
|
---|---|---|
DefaultFlag |
デフォルトフラグトークンに設定されたデフォルトフラグを返却します。 |
|
CardName |
カード名称何も設定されません。通常クレジットカードと項目をあわせる為に設置します。 |
|
CardNoToken |
カード番号トークントークン化されたカード番号を返却します。 |
|
Expire |
カード有効期限トークンに設定された有効期限を返却します。 |
|
HolderName |
名義人トークンに設定されたカード名義人を返却します。 |
|
DeleteFlag |
削除フラグトークンに設定された削除フラグを返却します。 |
TokenSeq=0001&DefaultFlag=&CardName=&CardNoToken=C1+2MnMKh7xuFkiOWHvJu7ToZo5Cp5yFrVafcPG5f2c=&Expire=2208&HolderName=ヤマダタロウ&DeleteFlag=
ErrCode=E01&ErrInfo=E01040001
SearchTradeMulti 取引状態参照
取引を照会し、その状態を確認できます。
レスポンス
正常
OrderID |
半角英数記号27桁
オーダーID
|
|
---|---|---|
Status |
半角英数15桁
取引状態
以下のいずれかを返却します。
|
|
ProcessDate |
半角数字14桁 固定
処理日時
処理を行った日時を返却します。
|
|
JobCd |
半角英数10桁
処理区分
以下のいずれかを返却します。
|
|
AccessID |
半角英数32桁 固定
取引ID
|
|
AccessPass |
半角英数32桁 固定
取引パスワード
|
|
ItemCode |
半角英数7桁
商品コード参照した取引に設定されている値を返却します。 |
|
Amount |
半角数字7桁
利用金額
|
|
Tax |
半角数字7桁
税送料
|
|
SiteID |
半角英数13桁
サイトID
|
|
MemberID |
半角英数60桁
会員ID
|
|
CardNoToken |
半角英数16桁
カード番号トークントークン化されたカード番号を返却します。 |
|
Expire |
半角数字4桁
有効期限参照した取引に設定されている値を返却します。 |
|
Method |
半角数字1桁 固定
支払方法1:一括を返却します。 |
|
PayTimes |
半角数字2桁
支払回数参照した取引に設定されている値を返却します。 |
|
Forward |
半角英数7桁
仕向先コード参照した取引に設定されている値を返却します。 |
|
TranID |
半角英数28桁
トランザクションID参照した取引に設定されている値を返却します。 |
|
Approve |
半角英数7桁
承認番号参照した取引に設定されている値を返却します。 |
|
ClientField1 |
全半角100バイト
加盟店自由項目1
|
|
ClientField2 |
全半角100バイト
加盟店自由項目2
|
|
ClientField3 |
全半角100バイト
加盟店自由項目3
|
|
PayType |
半角数字2桁
決済方法27:ApplePay(ブランドトークン) |
OrderID=ORDER0000001&Status=AUTH&ProcessDate=20220803113012&JobCd=AUTH&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&ItemCode=0000990&Amount=1000&Tax=100&SiteID=tsite99887701&MemberID=memberid001&CardNoToken=C1+2MnMKh7xuFkiOWHvJu7ToZo5Cp5yFrVafcPG5f2c=&Expire=2208&Method=1&PayTimes=&Forward=2a99663&TranID=2208031130111111111111750389&Approve=1602624&ClientField1=加盟店自由項目1 &ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=27
ErrCode=E01&ErrInfo=E01040001
決済結果受信
取引でイベント(オーソリ、実売上等)が発生した際、当サービスからの HTTP による push通知を利用可能です。
この機能の利用は任意であり、ご利用する場合管理画面より設定します。
通知は、イベント発生後速やかに行われます。また、通知に失敗した場合、最大 5 回まで 60 分おきに再送されます。
受信した加盟店様では、受信した応答を返却してください。また、加盟店様では特に不要な通知でも、正常として応答してください。
リクエスト(当サービス⇒加盟店様)
接続先URLは、加盟店様がショップ管理画面で設定したURLとなります。
OrderID |
半角英数記号27桁
オーダーID【取引状態参照】の呼出時に指定した値を返却します。 |
|
---|---|---|
Status |
半角英数16桁
取引状態以下のいずれを返却します。 |
|
ProcessDate |
半角数字14桁 固定
処理日時処理を行った日時を返却します。 |
|
JobCd |
半角英数10桁
処理区分以下のいずれかを返却します。 |
|
AccessID |
半角英数32桁 固定
取引ID参照した取引に設定されている値を返却します。 |
|
AccessPass |
半角英数32桁 固定
取引パスワード参照した取引に設定されている値を返却します。 |
|
ItemCode |
半角英数7桁
商品コード参照した取引に設定されている値を返却します。 |
|
Amount |
半角数字7桁
利用金額参照した取引に設定されている値を返却します。 |
|
SiteID |
半角英数13桁
サイトID参照した取引に設定されている値を返却します。 |
|
MemberID |
半角英数60桁
会員ID参照した取引に設定されている値を返却します。 |
|
CardNoToken |
半角英数16桁
カード番号トークントークン化されたカード番号を返却します。 |
|
Expire |
半角数字4桁
有効期限参照した取引に設定されている値を返却します。 |
|
Method |
半角数字1桁
支払方法以下のいずれかを返却します。 |
|
PayTimes |
半角数字2桁
支払回数参照した取引に設定されている値を返却します。 |
|
Forward |
半角英数7桁
仕向先コード参照した取引に設定されている値を返却します。 |
|
TranID |
半角英数28桁
トランザクションID参照した取引に設定されている値を返却します。 |
|
Approve |
半角英数7桁
承認番号参照した取引に設定されている値を返却します。 |